View step info

Returns information about a specific step of the journey, like the attribute type, the required level, whether it is the first or the last step, etc.

Syntax

Copy 
GET <host_address>/ftosapi/digital-journeys/{digital_journey_name}/view/{digitalJourneyItemName}/{entityFormSectionName}/{externalId}?culture=
 
 
Parameter Description
host_address The URL of the FintechOS platform server.
externalId The unique identifier of the digital journey.
digital_journey_name The name of the digital journey.
digitalJourneyItemName The name of the form driven flow.
entityFormSectionName The name of the step.
culture Optional parameter used to set the localization context, e.g. "?culture=ro-RO".
 
 

Response

Copy 
{
    "fields": [
        {
            "name": "string",
            "displayName": "string",
            "type": "bool",
            "value": true,
            "requiredLevel": 0,
            "isReadOnly": false
        },
        {
            "name": "string",
            "displayName": "string",
            "type": "text",
            "value": "NextCalledUpdate",
            "requiredLevel": 0,
            "isReadOnly": false
        }
    ],
    "journeyStepType": "default",
    "journeyName": "string",
    "journeyItem": "string",
    "journeyStep": "string",
    "instanceId": "e8f797ba-c664-4e21-80d1-c20b89d78238",
    "externalId": "e8f797ba-c664-4e21-80d1-c20b89d78238"

Examples

In this example, we request information about a particular step in the digital journey.

  • https://app-studio-ftosmaster-rc.azurewebsites.net is the URL of the FintechOS platform server.

  • 471474ae-65b2-4c15-9190-38995be0ea59 is the externalId of the digital journey.

  • OI_DJ1 is the name of the digital journey that the step is part of.

  • CustomerReferenceData is the name of the step we inquire about. The request is successful and returns details about the attributes found on the step.

Request

Copy 
GET /ftosapi/digital-journeys/OI_DJ1/view/Oi_DJF/CustomerReferenceData/471474ae-65b2-4c15-9190-38995be0ea59
Host: app-studio-ftosmaster-rc.azurewebsites.net
Content-Type: application/json

Response

Copy 
{
    "fields": [
        {
            "name": "ApplicationNumber",
            "displayName": "Application Number",
            "type": "text",
            "requiredLevel": 0,
            "isReadOnly": false
        },
        {
            "name": "DataOfBirth",
            "displayName": "Data of Birth",
            "type": "date",
            "requiredLevel": 0,
            "isReadOnly": false
        },
        {
            "name": "Email",
            "displayName": "Email",
            "type": "text",
            "value": "{\"Value\":{\"en-GB\":\"test\"}}",
            "requiredLevel": 0,
            "isReadOnly": false
        },
        {
            "name": "FirstName",
            "displayName": "First Name",
            "type": "text",
            "requiredLevel": 0,
            "isReadOnly": false
        },
        {
            "name": "LastName",
            "displayName": "Last Name",
            "type": "text",
            "requiredLevel": 0,
            "isReadOnly": false
        },
        {
            "name": "PhoneNumber",
            "displayName": "Phone Number",
            "type": "whole_number",
            "requiredLevel": 0,
            "isReadOnly": false
        }
    ],
    "journeyStepType": "default",
    "journeyName": "OI_DJ1",
    "journeyItem": "Oi_DJF",
    "journeyStep": "CustomerReferenceData",
    "instanceId": "471474ae-65b2-4c15-9190-38995be0ea59",
    "externalId": "471474ae-65b2-4c15-9190-38995be0ea59"
}

Errors

HTTP code Message

Context
404 Not Found No valid record found attached to the instance step. Occurs if a record is set on the InstanceStep and the recordId is not found in the database.